Skip to main content

Invoke HTTP Request

Overview


Invokes HTTP requests such as RESTful web services.

Input

NameRequiredDescription
API Toolkit
URL
Method
Headers

Query

NameRequiredDescription
Parameters
URL EncodeToggle on or off URL Encoding. Does NOT apply to FormURLEncoding option, that is always encoded.

Body

NameRequiredDescription
Body Type

String

NameRequiredDescription
Content
Content Type
NameRequiredDescription
FormAdd parameters and files to the body as a multipart form. For files, provide the name of the file for the "Name" property and the local file path for the "Value" property.

Form URL Encoded

NameRequiredDescription
Parameters
URL EncodeToggle on or off URL Encoding. Does NOT apply to FormURLEncoding option, that is always encoded.

File

NameRequiredDescription
File Path

Auth

NameRequiredDescription
Auth Type

Basic Auth Config

NameRequiredDescription
Username
Password

Bearer Token Config

NameRequiredDescription
Access Token

OAuth 1 Config

NameRequiredDescription
Consumer Key
Consumer Secret
Access Token
Token Secret
Signature

OAuth 2 Config

NameRequiredDescription
Token TypePrefix to the Access Token in the Authorization header. Leave empty to take default type from access token response (e.g. Bearer).
Access Token

Token Config

NameRequiredDescription
Grant Type
Scope
Add To Request URL
Access Token URL
Audience
Client ID
Client Secret
Username
Password

Advanced

NameRequiredDescription
Request Timeout (ms)Timeout of the request in milliseconds. Set to 0 for infinite timeout.
Response Content OptionConfigure how the response content is saved.
Download FolderUse when "Download File (To Folder)" option is selected. The file is downloaded to the provided folder. The file name will be acquired from the response headers if available.
Download File PathUse when "Download File (To File Path)" option is selected. The file is downloaded to the provided file path.
File ExtensionOverrides file extension of downloaded file.
Proxy ServerProxy to be used for all requests.

Output

NameRequiredDescription
Action SuccessTrue if the action passed, false if it failed.
Response Headers
Response Body
Response Status
Response URI
Request Success
Status Code
Status Message
Error MessageTransport or non-HTTP error.
Exception MessageException related to the request.